ClaimCenter Admin API (1.11.0)

APIs for InsuranceSuite administration objects

Create a new user

gw-childResourceType: User

gw-resourceType: Users

Authorizations:

basicAuth

query Parameters

fields

Array of strings

gw-allowForCompositeApi: true

Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form fields=<field list> or fields=<include>:<field list>, where <field list> consists of a comma-separated list of field or field set names. See the documentation for more information.

Request Body schema: application/json

required	object (UserData)
	object (AdminInclusions)

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"active": true,
"authorityLimitProfile": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"cellPhone": {"countryCode": {"code": "string",
"name": "string"
},
"extension": "string",
"number": "string"
},
"employeeNumber": "string",
"externalUser": true,
"firstName": "string",
"firstNameKanji": "string",
"gender": {"code": "string",
"name": "string"
},
"homePhone": {"countryCode": {"code": "string",
"name": "string"
},
"extension": "string",
"number": "string"
},
"lastName": "string",
"lastNameKanji": "string",
"particle": "string",
"pronounAggregate": {"code": "string",
"name": "string"
},
"pronounObjective": "string",
"pronounPossessive": "string",
"pronounSubjective": "string",
"roles": [{"id": "string"
}
],
"sexAssignedAtBirth": {"code": "string",
"name": "string"
},
"suffix": {"code": "string",
"name": "string"
},
"username": "string",
"vacationStatus": {"code": "string",
"name": "string"
},
"workPhone": {"countryCode": {"code": "string",
"name": "string"
},
"extension": "string",
"number": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
},
"included": {"AssignableQueue": [{"attributes": {"description": "string",
"name": "string",
"subGroupVisible": true
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"AuthorityLimit": [{"attributes": {"costType": {"code": "string",
"name": "string"
},
"coverageType": {"code": "string",
"name": "string"
},
"limitAmount": {"amount": "string",
"currency": "string"
},
"limitType": {"code": "string",
"name": "string"
},
"policyType": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"GroupUser": [{"attributes": {"loadFactor": 0,
"loadFactorType": {"code": "string",
"name": "string"
},
"manager": true,
"member": true,
"user": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"RolePermission": [{"attributes": {"permission": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
]
}
}

Response samples

Content type

application/json

{"data": {"attributes": {"active": true,
"authorityLimitProfile": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"cellPhone": {"countryCode": {"code": "string",
"name": "string"
},
"displayName": "string",
"extension": "string",
"number": "string"
},
"displayName": "string",
"employeeNumber": "string",
"externalUser": true,
"firstName": "string",
"firstNameKanji": "string",
"gender": {"code": "string",
"name": "string"
},
"groups": [{"displayName": "string",
"id": "string",
"type": "string",
"uri": "string"
}
],
"homePhone": {"countryCode": {"code": "string",
"name": "string"
},
"displayName": "string",
"extension": "string",
"number": "string"
},
"id": "string",
"lastName": "string",
"lastNameKanji": "string",
"particle": "string",
"pronounAggregate": {"code": "string",
"name": "string"
},
"pronounAggregateDisplay": "string",
"pronounObjective": "string",
"pronounPossessive": "string",
"pronounSubjective": "string",
"roles": [{"displayName": "string",
"id": "string",
"type": "string",
"uri": "string"
}
],
"sexAssignedAtBirth": {"code": "string",
"name": "string"
},
"suffix": {"code": "string",
"name": "string"
},
"username": "string",
"vacationStatus": {"code": "string",
"name": "string"
},
"workPhone": {"countryCode": {"code": "string",
"name": "string"
},
"displayName": "string",
"extension": "string",
"number": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
},
"included": {"AssignableQueue": [{"attributes": {"description": "string",
"id": "string",
"name": "string",
"subGroupVisible": true
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"AuthorityLimit": [{"attributes": {"costType": {"code": "string",
"name": "string"
},
"coverageType": {"code": "string",
"name": "string"
},
"id": "string",
"limitAmount": {"amount": "string",
"currency": "string"
},
"limitType": {"code": "string",
"name": "string"
},
"policyType": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"GroupUser": [{"attributes": {"id": "string",
"loadFactor": 0,
"loadFactorType": {"code": "string",
"name": "string"
},
"manager": true,
"member": true,
"user": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"RolePermission": [{"attributes": {"id": "string",
"permission": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
]
}
}

Was this page helpful?